home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / utility / sf5.zip / SF.DOC < prev    next >
Text File  |  1994-04-23  |  10KB  |  310 lines
  1.  
  2.  
  3.   SuperFind v5.0 (SF) utility (c) David L. Dight, 1993-4.
  4.                   All Rights Reserved.
  5.  
  6.                    _______
  7.               ____|__     |                (R)
  8.            --|       |    |-------------------
  9.              |   ____|__  |  Association of
  10.              |  |       |_|  Shareware
  11.              |__|   o   |    Professionals
  12.            -----|   |   |---------------------
  13.                 |___|___|    MEMBER
  14.  
  15.  
  16.  
  17. *********************************************************
  18.  
  19.   Additional copies and licences can be obtained from:
  20.  
  21.    P.O. Box 280,  Kings Cross, N.S.W.  2010  AUSTRALIA
  22.      Phone: +61 2 331 4521,  CompuServe: 100033,2563
  23.  
  24.   Please enclose US $9.50 for p/h.
  25.  
  26.  
  27.  
  28. *********************************************************
  29.  
  30. 1.                 What is SuperFind ?
  31.  
  32.  
  33. SF is an  improved file find utility.   Most file finders
  34. require the search  specification to be  passed with each
  35. invocation.  As  each directory  is  scanned,  files  are
  36. matched  with your file spec.   SF scans one, more or all
  37. drives  once only,  after  which,  you  simply  enter the
  38. file spec interactively and SF locates those files. Since
  39. SF  is   interactive,   successive   finds  can  be  made
  40. instantly and without time penalty.
  41.  
  42. File specs can  be in the form of a familiar file name or
  43. wildcard, or  alternatively,  a  filesize,  attribute(s),
  44. a date or even a date range.
  45.  
  46. Often when searching for files,  you wish to perform some
  47. operation  on them.   Usually  you'll  have to record the
  48. results of a  find,   create a  batch  file  or some such
  49. list  and  perform  those  operations.   With  SF you can
  50. specify a command string to execute on each found file.
  51.  
  52. SF substitutes the  '$'  in  your command string with the
  53. found file name and then executes the statement. This can
  54. be useful  in  situations like  removing all *.BAK files;
  55. copying all files in  a  date range to a diskette;  start
  56. applications  and so on.   When  SF executes a statement,
  57. it firstly swaps itself out of memory,   releasing memory
  58. for the executing statement.
  59.  
  60. Output  from  SF can be redirected to a file,  printer or
  61. COM  port  from  within   the  program,   permitting  the
  62. creation of file lists.
  63.  
  64.  
  65.  
  66. *********************************************************
  67.  
  68. 2.                  Running SuperFind
  69.  
  70.  
  71. usage: SF [-h?apldq] [[d:][directory]...]
  72.  
  73. When  SF is  run from the DOS prompt with  no parameters,
  74. all  logical  drives are  scanned  by  default.   You may
  75. alternatively  specify one  or more drives to limit those
  76. drives scanned, for example:
  77.  
  78.                         sf c: a:
  79.  
  80. this may be  useful when   running SF  on a network where
  81. scanning all drives may not be desirable.
  82.  
  83. SF  automatically  detects  a  drive  not ready condition
  84. avoiding the annoying DOS error message.
  85.  
  86. You  may  specify  a  specific  directory  to  scan,  for
  87. example:
  88.  
  89.                    sf \c700 d:\source
  90.  
  91. Any number of drives or directories can be specified.
  92.  
  93. SF  accepts  a  number  of  other switchable  parameters,
  94. described below...
  95.  
  96. -h      Prints the usage and switch summary.
  97.  
  98. -?      Prints the usage message only.
  99.  
  100. -a      Specifies to search all drives (default).
  101.  
  102. -p      When  SF executes a file spec, a pause message is
  103.         generated.  The  -p  switch  suppresses the pause
  104.         message.  This is useful on multi-file operations
  105.         like copy or delete.
  106.  
  107. -l<n>   Specifes  'n'  lines  per page when listing files
  108.         (default 24 lines). For example:
  109.  
  110.                        sf c: -l43
  111.  
  112.         scans the c: drive;  when  listing SF will use 43
  113.         lines per page.
  114.  
  115. -d<n>   Specifes  'n'  entries  per   directory  scanned.
  116.         (default 1024 entries).
  117.  
  118.                         sf -n256
  119.  
  120.         SF  will   limit   itself  to  256   entries  per
  121.         directory (useful to save memory).
  122.  
  123.  
  124. -q      Suppress verbose drive scan display.
  125.  
  126.  
  127.  
  128. *********************************************************
  129.  
  130. 3.                 SuperFind Commands
  131.  
  132. Commands  are  entered at the  ':' prompt after startup.
  133. These are as follows...
  134.  
  135.  
  136. N   -   Search   for    a    file   name   or    wildcard
  137.         specification.    Any  valid   DOS  file name  or
  138.         wildcard is acceptable, for example:
  139.  
  140.                        :fd??mu?.*
  141.  
  142.  
  143. A   -   Specify one or more attributes to search for.
  144.         These are:
  145.  
  146.             Token   Attribute          Value
  147.  
  148.             A       Archive             0x20
  149.             D       Sub directory       0x10
  150.             V       Volume ID           0x08
  151.             S       System              0x04
  152.             H       Hidden              0x02
  153.             R       Read Only           0x01
  154.             N       Normal              0x00
  155.  
  156.         for example (lower case OK):
  157.  
  158.                           :ash
  159.  
  160.         will search for files having the bits  'ASH' set,
  161.         so that a file with  'ASHR' would also be matched
  162.         and 'ASR' would not, and
  163.  
  164.                            :va
  165.  
  166.         will search for volume id's with the archive  bit
  167.         set.  Files  with  no  attributes  at  all can be
  168.         searched by specifying
  169.  
  170.                             :n
  171.  
  172.         for 'no' attribuites.
  173.  
  174.  
  175. D   -   Specify a a date and or time, or a date range.
  176.         SF will respond with:
  177.  
  178.                  Select <,=,> or R)ange:
  179.  
  180.         where...
  181.  
  182.             <       match  files  with   datestamps  less
  183.                     than or equal to a specified date.
  184.  
  185.             >       match files with  datestamps  greater
  186.                     than or equal to a specified date.
  187.  
  188.             =       match files with an exact datestamp.
  189.  
  190.             R       matches  file   within  an  inclusive
  191.                     date range.
  192.  
  193.         SF will then prompt you to  enter a  date or date
  194.         range.   You may  also specify a time value which
  195.         will  cause   SF  to  look  at file timestamps as
  196.         well.
  197.  
  198.  
  199. S   -   Specify a file size to search for.
  200.  
  201.  
  202. E   -   Execute a  command string for matching files.  SF
  203.         will prompt:
  204.  
  205.            Enter command to execute ($=substituted file):
  206.  
  207.         Enter  a DOS command line.  You should insert the
  208.         '$'  character  in  the  position  you  want  the
  209.         matched file to be substituted. For example:
  210.  
  211.                     xcopy $ a:\backup
  212.  
  213.         SF will then prompt you to enter...
  214.  
  215.             N)ame S)ize A)ttribute D)ate:
  216.  
  217.         which are  described above.  If  you  entered the
  218.         above command,  with the file spec set to D*.EXE,
  219.         SF would execute  the  following commands on each
  220.         find, for example:
  221.  
  222.            xcopy c:\dos\DEBUG.EXE a:\backup
  223.            xcopy c:\dos\DEFRAG.EXE a:\backup
  224.            xcopy c:\dos\DELTREE.EXE a:\backup
  225.            xcopy c:\dos\DOSSWAP.EXE a:\backup
  226.            .
  227.            .
  228.            .
  229.  
  230.         After each command  is executed,  SF  will pause,
  231.         allowing  you  to view output (press any key)  or
  232.         terminate successive executions (press 'q').
  233.  
  234.  
  235. L   -   Causes  SF  to  list  every  file  that has  been
  236.         scanned. SF will pause between each page.
  237.  
  238.  
  239. O   -   Specify  the  default output stream for  printing
  240.         matched file names or listings. Valid devices are
  241.         CON, PRN, COM.   You may also specify a file name
  242.         to redirect output to.   With no parameters, this
  243.         command  resets the  default  output to CON.   SF
  244.         will still pause between pages.   To  force SF to
  245.         list  files  continuously,   set  the page length
  246.         switch to 0, e.g.:
  247.  
  248.                          sf -l0
  249.  
  250.  
  251. Q   -   Quit.
  252.  
  253.  
  254. R   -   Force  SF  to  rescan  all  directories.   This is
  255.         useful if you have  already executed commands that
  256.         have altered  the  contents  of directory(s). e.g.
  257.         deletion or creation of files.
  258.  
  259. *   -   Print  a   brief   message  giving   details   on
  260.         distribution, site licences and donations.
  261.  
  262.  
  263. !   -   Invoke a DOS shell.   SF will swap itself  out of
  264.         memory to free all system memory to the shell.
  265.  
  266.  
  267. ?   -   Get Help on commands
  268.  
  269.  
  270.  
  271. *********************************************************
  272.  
  273. 4.                    Entry listings
  274.  
  275. When  SF  locates  file(s)  it produces a directory style
  276. listing in the following format:
  277.  
  278.  
  279.     C:\BIN
  280.         SF.EXE            77756 A       23-04-94 18:41:20
  281.  
  282. The directory in which the  file is located is printed on
  283. a  separate  line.   The  next  line consists of the full
  284. filename;  the  file  size in bytes;  the file attribute,
  285. where   A=archive,   S=system,   H=hidden,   D=directory,
  286. V=Volume,  N=Normal,   R=read-only;  the date and time of
  287. last write.
  288.  
  289. Sub-directory  entries  will show the total size in bytes
  290. of all entries in the directory.
  291.  
  292.  
  293.  
  294. *********************************************************
  295.  
  296. 5.                     Disclaimer
  297.  
  298. SF  v5.0  IS SUPPLIED  AS IS.    THE AUTHOR DISCLAIMS ALL
  299. WARRANTIES,  EXPRESSED  OR  IMPLIED,  INCLUDING,  WITHOUT
  300. LIMITATION, THE  WARRANTIES  OF  MERCHANTABILITY  AND  OF
  301. FITNESS FOR  ANY PURPOSE. THE AUTHOR ASSUMES NO LIABILITY
  302. FOR DAMAGES,  DIRECT OR  CONSEQUENTIAL, WHICH  MAY RESULT
  303. FROM THE USE OF SF v5.0.
  304.  
  305. GOOD DATA  PROCESSING PROCEDURE DICTATES THAT ANY PROGRAM
  306. BE  THOROUGHLY   TESTED  WITH  NON-CRITICAL  DATA  BEFORE
  307. RELYING ON  IT. THE  USER MUST  ASSUME THE ENTIRE RISK OF
  308. USING THE  PROGRAM.
  309.  
  310.